feat(cli): added --version and --help options #282
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added --version (-V) and --help (-h) options to the CLI for user interface.
Fixed a major bug with the version option in order to work from any directory
Uses dynamic import to import the node:path module when checking the version so it is not loaded when it is not needed.
fisker
reviewed
Jan 21, 2023
fisker
reviewed
Jan 21, 2023
|
Having just tested this revision on a windows OS, I can confirm that the help and version options work at the very least. It was not an extensive test, but I ran it with both options, ran it from a few different CWDs, and created a symlink and moved that around, and everything worked! |
fisker
reviewed
Jan 21, 2023
removes not needed call to fileURLToPath, replacing with the URL object itself
Removed try-catch block in --version which provided a default response if the file system requests failed.
|
This should now be ready for review. The try-catch block has been removed, and I removed the extra call/import to |
fisker
reviewed
Jan 22, 2023
fisker
reviewed
Jan 22, 2023
fisker
reviewed
Jan 22, 2023
Co-authored-by: fisker Cheung <lionkay@gmail.com>
fisker
reviewed
Jan 22, 2023
fisker
approved these changes
Jan 22, 2023
|
🎉 This PR is included in version 2.2.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
added --version (-V) and --help (-h) options to the CLI for user interface.
--helpoutput:This help menu can be easily modified in cli.js. It includes the option from #281, but that could be easily removed if so desired.
--versionoutput:Or other such versions. The version is pulled from the project.json file in the cli script's directory.
This is found by reading process.env[1], using fs.realpathSync, to read symlinks when it's installed, and path.dirname to get the parent directory. From there it is simple to read the file and call JSON.parse.